Tangoe Telecom SOAP API

22.2.x
(0 reviews)

APPENDIX D

VERSION CHANGE LOG

7.0 to 7.1

Inventory, Local service type – added Service Charges, Feature Charges, Access Charges and Common Equipment as standard fields.

InventoryDetails object in XSD was enhanced with featureCharges and commonEquipment ( serviceCharges and accessCharges were already present as they were used for other service types ).

<xsd:complexType name="InventoryDetails">
    <xsd:all>
     .........
        <xsd:element name="featureCharges" type="xsd:double" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="commonEquipment" type="xsd:double" maxOccurs="1" minOccurs="0"></xsd:element>
     .........
    </xsd:all>
</xsd:complexType>

The affected web methods are:

  • getInventoryItem() – when called for Local service type, featureCharges, commonEquipment, serviceCharges and accessCharges are included in the response message.
  • addInventoryItem() – when called for Local service type, featureCharges, commonEquipment, serviceCharges and accessCharges may be provided as part of the request message.
  • editInventoryItem() – when called for Local service type, featureCharges, commonEquipment, serviceCharges and accessCharges may be provided as part of the request message.
  • findInventoryItem() – when called for Local service type, items may be searched after featureCharges, commonEquipment, serviceCharges _and _accessCharges if desired.
7.1 to 7.2

The following user processing methods have been added:

  • findProfile() – extract the profile ID / Name / Description based on the prefix of the profile name
  • addUser()- Add user in the system
  • editUser()- Edit existing user
  • deleteUser()- Mark user as deleted
  • getUserID()- find user ID based on user name
7.2 to 8.0

Inventory:

Local service type – standard field Common Equipment was renamed to Equipment Charges

The property commonEquipment _was removed from the _InventoryDetails object in XSD; (equipmentCharges was already present as it was used for other service types).

<xsd:complexType name="InventoryDetails">
    <xsd:all>
          .........
        <xsd:element name="equipmentCharges" type="xsd:double" maxOccurs="1" minOccurs="0"></xsd:element>
          .........
    </xsd:all>
</xsd:complexType>

The affected web methods are:

  • getInventoryItem() – when called for Local service type, equipmentCharges is included in the response message.
  • addInventoryItem() – when called for Local service type, equipmentCharges may be provided as part of the request message.
  • editInventoryItem() – when called for Local service type, equipmentCharges may be provided as part of the request message.
  • findInventoryItem() – when called for Local service type, items may be searched after equipmentCharges if desired.

Vendor contracts were added as a major improvement in Telecom 8.0. They are also present in the web services.

a.) Obsolete object VendorPlan was removed. Two new object were created in the XSD: VendorContract and RatePlan.

<xsd:simpleType name="VendorContract">
    <xsd:restriction base="xsd:string">
        <xsd:minLength value="0"></xsd:minLength>
        <xsd:maxLength value="255"></xsd:maxLength>
    </xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="RatePlan">
    <xsd:restriction base="xsd:string">
        <xsd:minLength value="0"></xsd:minLength>
        <xsd:maxLength value="255"></xsd:maxLength>
    </xsd:restriction>
</xsd:simpleType>

b.) The InventoryDetails object in XSD was modified to accommodate the new vendor contracts. New fields were added: vendorContract, ratePlan, localLDVendor, localLDContract, ldLocalVendor, ldLocalContract. The type for the field localTollContract _was changed from VendorPlan_ to VendorContract. The obsolete fields otherVendor and planType were removed.

<xsd:complexType name="InventoryDetails">
  <xsd:all>
.........
   <xsd:element name="vendorContract" type="tns:VendorContract"
                  maxOccurs="1" minOccurs="0"></xsd:element>
   <xsd:element name="ratePlan" type="tns:RatePlan"
                  maxOccurs="1" minOccurs="0"></xsd:element>
   <xsd:element name="localLDVendor" type="tns:Vendor"
                  maxOccurs="1" minOccurs="0"></xsd:element>
   <xsd:element name="localLDContract" type="tns:VendorContract"
                  maxOccurs="1" minOccurs="0"></xsd:element>
   <xsd:element name="localTollVendor" type="tns:Vendor"
                  maxOccurs="1" minOccurs="0"></xsd:element>
   <xsd:element name="localTollContract" type="tns:VendorContract"
                  maxOccurs="1" minOccurs="0"></xsd:element>
   <xsd:element name="ldLocalVendor" type="tns:Vendor"
                  maxOccurs="1" minOccurs="0"></xsd:element>
   <xsd:element name="ldLocalContract" type="tns:VendorContract"
                  maxOccurs="1" minOccurs="0"></xsd:element>
.........
  </xsd:all>
</xsd:complexType>

The affected web methods are:

  • getInventoryItem()
  • addInventoryItem()
  • editInventoryItem()
  • findInventoryItem()
8.0 to 9.11

Due to the upgrade of the Spring library version the WSDL port name was changed

From:

<wsdl:port binding="schema:InvOrderBinding" name="InvOrderPort">

To:

<wsdl:port binding="tns:InvOrderSoap11" name="InvOrderSoap11">

The number of record brought by find methods was defaulted to 50 in case the maxNoRecords parameter is missing, instead of bringing all items.The affected web methods are:

  • findInventoryItem()
  • findEquipment()
  • findEmployee()
  • findCostCenter()
  • findSplit()

New functionalities added in the main Telecom application 9.1 are NOT reflected in the web services (Location Z, Location Shipping, Equipment Orders etc.).

9.1 to 9.31

Inventory:

  • new fields added: locationNo, locationZ, usageVendor, usageContract
<xsd:complexType name="InventoryDetails">
    <xsd:all>
         .........
        <xsd:element name="locationNo" type="tns:Location" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="locationZ" type="tns:Location" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="usageVendor" type="tns:Vendor" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="usageContract" type="tns:VendorContract" maxOccurs="1" minOccurs="0"></xsd:element>
        .........
    </xsd:all>
</xsd:complexType>

The affected web methods are:

  • getInventoryItem()
  • addInventoryItem()
  • editInventoryItem()
  • findInventoryItem()

Order:

  • order management was enhanced to support multiple items on the same orders
  • orders can be placed for Equipment items
  • the object contained in the edit request was changed from OrderDetails _to _EditOrderDetails
  • removed fields: inventoryNumber
  • new fields added: orderAccountNo, shippingAddress, vendor, deviceTypeID, inventoryNumbers
  • please see the Apenmdix section for the new structure of the OrderDetails object and the new EditOrderDetails object

The affected web methods are:

  • addOrder()
  • editOrder()
  • getOrder()
  • getOrdersForInventory()

Two new web methods were added:

  • addItemsToOrder() – add existing items to an existing order
  • removeItemsFromOrder() – remove items from an existing order

Employee:

  • new fields added: title, reportsTo, ccRights
<xsd:complexType name="EmployeeDetails">
    <xsd:all>
     ............
        <xsd:element name="reportsTo" type="tns:EIN" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="ccRights" type="tns:CostCenterNos" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="title" type="tns:Title" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>
9.3 to 9.4

Inventory:

  • new fields added: secondaryVendor, secondaryVendorContract, upgradeEligibilityDate
<xsd:complexType name="InventoryDetails">
    <xsd:all>
     .....................
        <xsd:element name="secondaryVendor" type="tns:Vendor" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="secondaryContract" type="tns:VendorContract" maxOccurs="1" minOccurs="0"></xsd:element>
     .........
        <xsd:element name="upgradeEligibilityDate" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>
<xsd:complexType name="EquipmentDetails">
    <xsd:all>
     ........................
        <xsd:element name="upgradeEligibilityDate" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>

The affected web methods are:

  • getInventoryItem()
  • addInventoryItem()
  • editInventoryItem()
  • findInventoryItem()

Orders:

  • new fields added: Owner and Notes
<xsd:complexType name="OrderDetails">
    <xsd:all>
        ........................
        <xsd:element name="ownerUserId" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="notes" type="tns:Notes" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>
<xsd:complexType name="EditOrderDetails">
    <xsd:all>
        .....................
        <xsd:element name="ownerUserId" type="xsd:int" maxOccurs="1" minOccurs="0">
        </xsd:element>
        <xsd:element name="notes" type="tns:Notes" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>
<xsd:simpleType name="Notes">
    <xsd:restriction base="xsd:string">
        <xsd:minLength value="0"></xsd:minLength>
        <xsd:maxLength value="4000"></xsd:maxLength>
    </xsd:restriction>
</xsd:simpleType>

The affected web methods are:

  • addOrder()
  • editOrder()
  • getOrder()
  • getOrdersForInventory()
9.4 to 10

Inventory:

  • new field added: wirelessDeviceType
<xsd:complexType name="InventoryDetails">
    <xsd:all>
        .........
        <xsd:element name="wirelessDeviceType" type="tns:WirelessDeviceType" maxOccurs="1" minOccurs="0">
        </xsd:element>
        .........
    </xsd:all>
</xsd:complexType>

The affected web methods are:

  • getInventoryItem()
  • addInventoryItem()
  • editInventoryItem()
  • findInventoryItem()

Orders:

Validation of Order Number was changed to contain white-spaces.

<xsd:simpleType name="OrderNumber">
    <xsd:restriction base="xsd:string">
        <xsd:minLength value="0"></xsd:minLength>
        <xsd:maxLength value="100"></xsd:maxLength>
        <xsd:pattern value="[^("%'`\\)]*"></xsd:pattern>
</xsd:restriction>
</xsd:simpleType>

The affected web methods are:

  • editOrder()
  • addOrder()
10 to 10.1

No changes occurred in the schema definition, just a small note for the Get/Add/Edit/Find Inventory, Get/Add/Edit Orders, and Get Custom Fields Requests:

  • For Inventory or Orders – we will also support the Common Custom Fields that are defined. If previously the response would have contained only the service type/device type specific custom field elements for a particular service type/device type, we will now include apart from those custom fields, the custom fields that are defined as common for that category (Inventory or Orders). The common custom fields are supported for all Get/Add/Edit/Find web services for the Inventory and Orders items.
  • The GetCustomFieldsRequest will return, for Inventory and Orders, the custom fields defined for the requested service type, including the Common defined custom fields across that category.
10.1 to 11.0

Inventory:

  • 3 new fields were added: voicePool, dataPool, messagingPool
  • 1 field has been removed: wirelessPool
<xsd:complexType name="InventoryDetails">
    <xsd:all>
        .........
        <xsd:element name="voicePool" type="tns:VoicePool" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="dataPool" type="tns:DataPool" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="messagingPool" type="tns:MessagingPool" maxOccurs="1" minOccurs="0"></xsd:element>
        .........
    </xsd:all>
</xsd:complexType>

The affected web methods are:

  • getInventoryItem()
  • addInventoryItem()
  • editInventoryItem()
  • findInventoryItem()
11.0 to 18.1

No changes.

18.1 to 19.1

No changes.

19.1 to 19.2

Inventory:

  • added support for dynamic service types
  • 1 field has been added
<xsd:complexType name="InventoryDetails">
    <xsd:all>
        .........
        <xsd:element name="dynamicFields" type="tns:InventoryDynamicFields" maxOccurs="1" minOccurs="0"></xsd:element>
        .........
    </xsd:all>
</xsd:complexType>

The affected web methods are :

  • getInventoryItem()
  • addInventoryItem()
  • editInventoryItem()
  • findInventoryItem()

One new web method has been added, getDynamicFields() which will return the list of dynamic fields for a provided dynamic service type.

The New Service Types have the same static (standard) fields as the Telecom Legacy Service Types, and dynamic fields specific for the new service type along with custom fields – which also as the Telecom Legacy Service Types include global fields and service type specific fields.

Difference between the Legacy Service Types and New Service Types from web services perspective would be that the specific fields for New Service Types have also sections separately in the response message.

Request for _getDynamicFields() _method:

<SOAP-ENV:Body>
  <tns:GetDynamicFieldsRequest
   xmlns:tns="http://www.asentinel.com/asentinelws/schemas/invord">
   <tns:serviceTypeID>32</tns:serviceTypeID> </tns:GetDynamicFieldsRequest>
</SOAP-ENV:Body>

Response for getDynamicFields() method:

For new service type VOIP as example the response would contain following but not limited to:

<SOAP-ENV:Body>
<ns2:GetDynamicFieldsResponse
             xmlns:ns2="http://www.asentinel.com/asentinelws/schemas/invord">
      <ns2:dynamicField>
                    <ns2:id>1</ns2:id>
                    <ns2:name>COS</ns2:name>
                    <ns2:value/>
                    <ns2:fieldType>String</ns2:fieldType>
                    <ns2:required>false</ns2:required>
               </ns2:dynamicField>
<ns2:dynamicField>
                    <ns2:id>2</ns2:id>
                    <ns2:name>CosCharges</ns2:name>
                    <ns2:value/>
                    <ns2:fieldType>Double</ns2:fieldType>
                    <ns2:required>false</ns2:required>
                </ns2:dynamicField>
     <ns2:dynamicField>
                    <ns2:id>3</ns2:id>
                    <ns2:name>PortSpeed</ns2:name>
                    <ns2:value/>
                    <ns2:fieldType>String</ns2:fieldType>
                    <ns2:required>false</ns2:required>
                </ns2:dynamicField>
       <ns2:dynamicField>
                    <ns2:id>4</ns2:id>
                   <ns2:name>PortCharges</ns2:name>
                    <ns2:value/>
                    <ns2:fieldType>Double</ns2:fieldType>
                    <ns2:required>false</ns2:required>
            </ns2:dynamicField>
    ....
<ns2:result>
               <ns2:code>0</ns2:code>
               <ns2:message>OK</ns2:message>
            </ns2:result>
        </ns2:GetDynamicFieldsResponse>
</SOAP-ENV:Body>

Example response for adding a new inventory for new Service Type VOIP with ID 32.

    <SOAP-ENV:Body>
<ns2:AddInventoryItemResponse         xmlns:ns2="http://www.asentinel.com/asentinelws/schemas/invord">
                    <ns2:inventoryID>609438</ns2:inventoryID>
                    <ns2:result>
                    <ns2:code>0</ns2:code>
                    <ns2:message>OK</ns2:message>
                    </ns2:result>
                </ns2:AddInventoryItemResponse>
   </SOAP-ENV:Body>

Response for getInventoryItem() to display the custom fields associated for new service type VOIP and dynamic fields.

<SOAP-ENV:Body>
                <ns2:GetInventoryItemResponse
                  xmlns:ns2="http://www.asentinel.com/asentinelws/schemas/invord">
                    <ns2:inventoryItem>
                    <ns2:inventoryID>609439</ns2:inventoryID>
                    <ns2:serviceTypeID>5</ns2:serviceTypeID>
                    <ns2:inventoryNumber>test_inventoryItem_002</ns2:inventoryNumber>
                    <ns2:costCenterNo>1014</ns2:costCenterNo>
                    <ns2:glAccount>split_gl_account</ns2:glAccount>
                    <ns2:address/>
                    <ns2:city/>
                    <ns2:state/>
                    <ns2:zip/>
                    <ns2:country/>
                    <ns2:locationNo/>
                    <ns2:primaryUse/>
                    <ns2:vendor>AT</ns2:vendor>
                    <ns2:vendorContract/>
                    <ns2:localLDVendor/>
                    <ns2:localLDContract/>
                    <ns2:localTollVendor/>
                    <ns2:localTollContract/>
                    <ns2:dateActivated>05/05/2020</ns2:dateActivated>
                    ….
                    <ns2:equipmentCharges>0.0</ns2:equipmentCharges>
                    <ns2:accessCharges>0.0</ns2:accessCharges>
                    <ns2:serviceCharges>0.0</ns2:serviceCharges>
                    <ns2:featureCharges>0.0</ns2:featureCharges>
                    <ns2:customFields>
                        <ns2:customField>
                            <ns2:id>197724</ns2:id>
                            <ns2:name>date</ns2:name>
                            <ns2:value/>
                            <ns2:fieldType>Date</ns2:fieldType>
                            <ns2:required>false</ns2:required>
                        </ns2:customField>
                       <ns2:customField>
                            <ns2:id>197479</ns2:id>
                            <ns2:name>Sub-Type</ns2:name>
                            <ns2:value/>
                            <ns2:fieldType>Combo</ns2:fieldType>
                            <ns2:required>false</ns2:required>
                        </ns2:customField>
                     <ns2:customField>
                            <ns2:id>197495</ns2:id>
                            <ns2:name>LEC ID</ns2:name>
                            <ns2:value/>
                            <ns2:fieldType>String</ns2:fieldType>
                            <ns2:required>false</ns2:required>
                        </ns2:customField>
                      <ns2:customField>
                            <ns2:id>197644</ns2:id>
                            <ns2:name>VOIP test</ns2:name>
                           <ns2:value/>
                            <ns2:fieldType>String</ns2:fieldType>
                            <ns2:required>false</ns2:required>
                        </ns2:customField>
                    </ns2:customFields>
                    <ns2:comments/>
                     </ns2:inventoryItem>
                    <ns2:result>
                    <ns2:code>0</ns2:code>
                    <ns2:message>OK</ns2:message>
                    </ns2:result>
                </ns2:GetInventoryItemResponse>
    </SOAP-ENV:Body>

Example response for a new inventory for a Telecom Legacy Service Type Local with ID 5. Response for getInventoryItem() to display standard and custom fields associated with Local legacy service type.

<SOAP-ENV:Body>
                <ns2:GetInventoryItemResponse
                  xmlns:ns2="http://www.asentinel.com/asentinelws/schemas/invord">
                    <ns2:inventoryItem>
                    <ns2:inventoryID>609439</ns2:inventoryID>
                    <ns2:serviceTypeID>5</ns2:serviceTypeID>
                    <ns2:inventoryNumber>test_inventoryItem_002</ns2:inventoryNumber>
                    <ns2:costCenterNo>1014</ns2:costCenterNo>
                    <ns2:glAccount>split_gl_account</ns2:glAccount>
                    <ns2:address/>
                    <ns2:city/>
                    <ns2:state/>
                   <ns2:zip/>
                    <ns2:country/>
                    <ns2:locationNo/>
                    <ns2:primaryUse/>
                    <ns2:vendor>AT</ns2:vendor>
                    <ns2:vendorContract/>
                    <ns2:localLDVendor/>
                    <ns2:localLDContract/>
                    <ns2:localTollVendor/>
                    <ns2:localTollContract/>
                    <ns2:dateActivated>05/05/2020</ns2:dateActivated>
                    ….
                    <ns2:equipmentCharges>0.0</ns2:equipmentCharges>
                    <ns2:accessCharges>0.0</ns2:accessCharges>
                    <ns2:serviceCharges>0.0</ns2:serviceCharges>
                    <ns2:featureCharges>0.0</ns2:featureCharges>
              <ns2:customFields>
                        <ns2:customField>
                            <ns2:id>197724</ns2:id>
                            <ns2:name>date</ns2:name>
                            <ns2:value/>
                            <ns2:fieldType>Date</ns2:fieldType>
                            <ns2:required>false</ns2:required>
                        </ns2:customField>
                       <ns2:customField>
                            <ns2:id>197479</ns2:id>
                            <ns2:name>Sub-Type</ns2:name>
                            <ns2:value/>
                            <ns2:fieldType>Combo</ns2:fieldType>
                            <ns2:required>false</ns2:required>
                        </ns2:customField>
                     <ns2:customField>
                            <ns2:id>197495</ns2:id>
                            <ns2:name>LEC ID</ns2:name>
                            <ns2:value/>
                            <ns2:fieldType>String</ns2:fieldType>
                            <ns2:required>false</ns2:required>
                        </ns2:customField>
                      <ns2:customField>
                            <ns2:id>197644</ns2:id>
                            <ns2:name>VOIP test</ns2:name>
                           <ns2:value/>
                            <ns2:fieldType>String</ns2:fieldType>
                            <ns2:required>false</ns2:required>
                        </ns2:customField>
                    </ns2:customFields>
                    <ns2:comments/>
                     </ns2:inventoryItem>
                    <ns2:result>
                    <ns2:code>0</ns2:code>
                    <ns2:message>OK</ns2:message>
                    </ns2:result>
                </ns2:GetInventoryItemResponse>
    </SOAP-ENV:Body>

Custom Fileds:

  • Enhanced the getCustomFields() endpoint to include the available options for the combo ones
  • CustomField complex type was enhanced with the optional Options member.
  • For an Option:
    • id - represents the unique identifier of the custom field option ( this is the value retrieved or required to be sent as the value of a certain custom field )
    • name – represents the description of the option
<xsd:complexType name="CustomField">
        <xsd:sequence>
            ……
            <xsd:element name="options" type="tns:Options" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="Options">
        <xsd:sequence>
            <xsd:element name="option" type="tns:Option"
                  maxOccurs="unbounded" minOccurs="0"></xsd:element>
        </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="Option">
        <xsd:sequence>
            <xsd:element name="id" type="xsd:int" maxOccurs="1"
                  minOccurs="1"></xsd:element>
<xsd:element name="name" type="xsd:string" maxOccurs="1"
      minOccurs="1"></xsd:element>
        </xsd:sequence>
</xsd:complexType>
19.2 to 19.3

Inventory:

  • added support for three New Service Types - Colocation, Dark Fiber and Ethernet
  • modified the way VOIP service type is handled - dynamicFileds element was removed from InventoryDetails
  • InventoryDetails complex type was enhanced with the following missing attributes:
<xsd:complexType name="InventoryDetails">
<xsd:all>
    …
<xsd:element name="piccCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="otherCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="oneTimeCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="advertisingCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="daCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="domesticCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="intCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="usageCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="itemizedCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="coloOtherCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="powerCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="spaceCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="crossConnectCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
<xsd:element name="supportCharges" type="xsd:double" maxOccurs="1"
      minOccurs="0"></xsd:element>
    …
</xsd:all>
</xsd:complexType>

The affected web methods are:

  • getInventoryItem()
  • addInventoryItem()
  • editInventoryItem()
  • findInventoryItem()

getDynamicFields() web method was removed.

The New Service Types have the same static (standard) fields as the Telecom Legacy Service Types plus specific dynamic fields. All dynamic fields are fully supported. In order to know which attributes from among the ones of tns: InventoryDetails are used for which service type, please check Appendix A, Inventory Details object.

19.3 to 20.1

No changes.

20.1 to 20.2

No changes.

20.2 to 21.1

Order notes are treated differently as part of the editOrder() operation.

21.1 to 21.2

Inventory:

  • suspend or reactivate an inventory for all service types (including equipment), which is applied only for items considered as active in terms of dateActivated and dateDeactivated fields.

a) suspended = “false”

Sample request sent:

...

...

Result – suspended = “false”

b) suspended = “false”

Sample request sent:

...

true...

Result – if isActive - suspended = “true” else - suspended = “false”

c) suspended = “true”

Sample request sent:

...

false...

Result – if not isActive - suspended = “false” else - suspended = “true”

  • remove Location value, which applies only when Location property is configured on true in the application;

a) locationNo = “Existing Location”

Sample request sent:

...

...

Result – locationNo = “Existing Location”

b) locationNo = “Existing Location”

Sample request sent:

...

New Location...

Result – locationNo = “New Location”

c) locationNo = “Existing Location”

Sample request sent:

...

...

Result - if - property locationid = ON (TIMS.properties for WS) and Location field is required (user rights) -> Error - Field Location No. is required.

-remove Assigned Employee value;

a) AssignTo = “12345”

Sample request sent:

...

...

Result – AssignTo = “12345”.

b) AssignTo = “1111111111”

Sample request sent:

...

222222222222...

Result – AssignTo = “222222222222”.

c) AssignTo = “1111111111”

Sample request sent:

...

...

Result – AssignTo = “” (REMOVED)

  • new fields were added in findInventoryItem() request:

    1. lastActionDate - optional; include everything after this date
    2. fromRecord - optional; fetch records starting from this index (zero based)
    3. maxNoOfRecords - optional; fetch only maximum number of records

  • new fields were added in findInventoryItem() response:

    1. customFields - optional; the list of custom fields of the item
    2. lastActionDate - optional; shows the last date when the item was modified
    3. totalRecords - optional; shows the total number of items that match the search criteria

  • pagination can be achieved by using the parameters fromRecord and maxNoOfRecords

21.2 to 22.2

  • Missing fields were added for the Wireless Service Type for all Inventory end points. The fields are nonPooledServiceCharges, pooledServiceCharges, downloadCharges _and _assignedEquipment.

Reviews